Skip to main content

Simulate bankslip payment conclusion

Sandbox environment only

This simulation endpoint is available only in the homologation environment. Do not use this route in production flows.

Use this route to simulate the conclusion of a bankslip charge in the homologation environment.

Request

POST 'https://apisandbox.delbank.com.br/baas/v1/charges/{id}/simulate-conclude'

Headers

NameDescription
x-delbank-api-keyRequired. API key
x-delfinance-account-idRequired. The Delfinance bank account number

Path parameters

NameTypeDescription
idstringRequired. Bankslip charge identifier. Use the digitable line or the barcode.

Request body

NameTypeDescription
typestringRequired. Simulation type. Use BANKSLIP.

Request body example

{
"type": "BANKSLIP"
}

Response

The expected response is 202 Accepted.

{
"correlationId": "string",
"referenceId": "string",
"amount": 150.5,
"source": "PCR",
"date": "2026-05-21T13:30:15Z",
"paymentDate": "2026-05-21T13:30:15Z",
"issuer": {
"ispb": "string",
"code": "string",
"branch": "string",
"agency": "string",
"name": "string",
"type": "PJ",
"document": "string",
"fantasyName": "string"
},
"additionalData": {
"simulator": "DelbankSimulator",
"message": "Pagamento de boleto simulado em ambiente de homologação",
"bankAccount": "string",
"correlationId": "string",
"ourNumber": "string",
"barCode": "string",
"digitableLine": "string"
}
}

Possible errors

Payment type not informed

Status: 400 Bad Request

{
"title": "Please refer to the errors property for additional details.",
"errors": [
"Tipo de pagamento não pode ser nulo"
]
}

Invalid type

Status: 400 Bad Request

{
"title": "Please refer to the errors property for additional details.",
"errors": [
"Tipo de pagamento inválido"
]
}

Identifier not informed

Status: 400 Bad Request

{
"title": "Please refer to the errors property for additional details.",
"errors": [
"Identificador da cobrança deve ser informado"
]
}